Skip to content

docs(analyze): add rule zip setup path for external contributors#416

Merged
timenick merged 4 commits into
mainfrom
zhiwang/docs-rules-external-contributors
Apr 29, 2026
Merged

docs(analyze): add rule zip setup path for external contributors#416
timenick merged 4 commits into
mainfrom
zhiwang/docs-rules-external-contributors

Conversation

@timenick

@timenick timenick commented Apr 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a new top option in runtime_check_rules/README.md instructing external contributors to download rule zips from the latest WinML-ModelKit release. Existing gim-home-based options are demoted to "Microsoft internal" and renumbered.
  • Adds a "Runtime check rules subsection to CONTRIBUTING.md so external contributors know they need rule zips and where to get them.
  • Updates scripts/download_rules.py docstring and the "missing account" error message to direct external users to the release download.

Fixes #415

Add a public, no-access-required path for obtaining runtime check rule zips
via the latest WinML-ModelKit GitHub release. Document this in the rule
directory README and in CONTRIBUTING.md, and update download_rules.py to
redirect external users to the release when they invoke the internal script
without a gim-home account.

Fixes #415
@timenick timenick requested a review from a team as a code owner April 29, 2026 02:40
@timenick timenick merged commit 0d0fff7 into main Apr 29, 2026
9 checks passed
@timenick timenick deleted the zhiwang/docs-rules-external-contributors branch April 29, 2026 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document rule zip setup for external contributors (no gim-home access)

2 participants